home *** CD-ROM | disk | FTP | other *** search
/ Tech Arsenal 1 / Tech Arsenal (Arsenal Computer).ISO / tek-05 / intel593.zip / INTEL593.DOC < prev    next >
Text File  |  1993-04-19  |  14KB  |  422 lines
  1.     
  2.  AI-LANBIOS Low-level Driver for the Intel 82593 MLM hardware and derivatives 
  3.                   (INTEL593.DOC)
  4.  ----------------------------------------------------------------------------
  5.              (C) Copyright 1992 ARTISOFT, Inc.
  6.          Portions Copyright 1992-93 Intel Corporation
  7.  
  8. Introduction
  9. ============
  10.  
  11. The INTEL593 low-level AI-LANBIOS driver for Intel's "82593-MLM hardware 
  12. and derivatives" was developed by Intel Corp. in conformance with the 
  13. specifications outlined in the Artisoft AI-LANBIOS Driver Development Program.  
  14. The low-level driver interfaces directly to the network hardware and
  15. provides basic unreliable data transfer capabilities.  The AI-LANBIOS
  16. high-level driver provides the reliable data transfer capabilities
  17. including all NETBIOS functions.
  18.  
  19. The INTEL593 driver makes use of two system DMA channels for data transfer
  20. operations. It also requires memory from the system memory space for its
  21. transmit and receive buffers. This approach does not require any memory on
  22. the board.
  23.  
  24. NOTE:   As two DMA channels are used by one "82593-MLM hardware", 
  25.     it is not possible to have more than one INTEL593 driver installed
  26.     in the same system.
  27.  
  28. Compatibility Statement
  29. =======================
  30.  
  31. Version 3.10 of INTEL593 is compatible with Artisoft's LANtastic/AI Network
  32. Operating System v4.1, except for the following functional considerations:
  33.  
  34. -INTEL593 driver requires two additional command line switches for its use 
  35.  of system DMA channels.
  36. -If a NETID Block is found on the computer in which the 82593 is installed, 
  37.  the parameter values obtained from NETID Block will override the command 
  38.  line switch values.
  39.  
  40. Vendor Information
  41. ==================
  42.  
  43. Intel Connectivity Division. 1900, Prairie City Road, MS FM4-27.
  44. Folsom, CA-95630.  Fax# 916-356-6289 (attn: ICD Product Marketing)
  45.  
  46. Running INTEL593
  47. ================
  48.  
  49. The INTEL593 low-level driver must be run before the AI-LANBIOS.  The
  50. INTEL593 driver interfaces to the AI-LANBIOS using a DOS multiplex
  51. interrupt number.  The default multiplex number is C7.  If you are only
  52. running one low-level driver and one copy of AI-LANBIOS then you will
  53. not have to worry about which multiplex number to assign.  Multiplex
  54. numbers 00 through BF are reserved for DOS use so you must use a multiplex
  55. number between C0 through FF.
  56.  
  57. One invocation of the INTEL593 driver supports one "Intel 82593-MLM hardware
  58. or derivative".  Multiple copies can not be run as enough DMA Channels are 
  59. not available.
  60.  
  61. The INTEL593 low-level driver program name is INTEL593.EXE.  The syntax for
  62. INTEL593 is
  63.  
  64.      INTEL593[switches . . . ] [ ; comment]
  65.  
  66. where [switches . . . ] denotes zero or more optional command line switches. 
  67. Switches may be delimited by blanks or slashes (/).  If a switch takes a
  68. value, the switch must be followed by an equal sign (=) or a colon (:).
  69. Some values may be hexadecimal numbers while other values may be decimal.
  70. All switch values are range checked and illegal values produce errors.
  71.  
  72. You may place a comment on the command line by preceding the comment with
  73. a semicolon (;).  You must precede the comment character with a blank.
  74.  
  75. The valid switch formats are:
  76.  
  77.      SWITCH
  78.      SWITCH:value
  79.      /SWITCH
  80.      @file
  81.  
  82. The valid INTEL593 switches are enumerated below.  The letters "ddd"
  83. denote a decimal number.  The letters "hh" denote a hexadecimal number. 
  84. Values enclosed in [] indicate default values if the switch is omitted. 
  85. Values after [] denote the valid range of the switch. 
  86.  
  87. ----------
  88.     @switch-file
  89.  
  90. This option specifies that further switches are to be taken from an
  91. switch file.  Any switches after the @switch-file name will be used,
  92. and the switch settings take precedence over any settings in the switch
  93. file.  You may invoke switch files from within switch files as often as
  94. you wish.  The file should contain valid switches and may contain comment
  95. characters (;) at the beginning of each line or after switches.
  96.  
  97. For example,
  98.  
  99.     INTEL593 @setup
  100.  
  101. The file SETUP contains
  102.  
  103.     ; INTEL593 AI-LANBIOS driver setup file
  104.  
  105.     IOBASE=300            ; Use I/O address 300
  106.     verbose               ; Display verbose information
  107.  
  108. ----------
  109.     HELP or ?
  110.  
  111. This switch displays information about the valid command line switches,
  112. but does not install the INTEL593 driver.  For example,
  113.  
  114.     INTEL593/help
  115.     INTEL593 ?
  116.  
  117. See the messages section for a detailed description of the HELP display
  118. output.
  119.  
  120. ----------
  121.     XEROX  [OFF]               
  122.  
  123. This switch specifies that support for XEROX style packets has to be  
  124. provided. Specifying this switch will force the driver to transmit only
  125. XEROX style packets.  
  126.  
  127. NOTE: This doesn't affect the receive operation. The driver will continue  
  128. to receive IEEE802.3 style packets.
  129.  
  130. ----------
  131.     IOBASE=hhhh [300] 0000-03e0 
  132.  
  133. This switch specifies the I/O base address configured on the hardware 
  134. containing Intel 82593.
  135. The IOBASE switch value must match the value specified on hardware.        
  136. The default value is IOBASE of 300.
  137.  
  138. Unless you have changed the settings on the hardware, the IOBASE switch is 
  139. unnecessary, as the driver default is same as the factory default.
  140.  
  141. ----------
  142.     TX_DMA=dd [6] 6-7
  143.  
  144. This switch specifies the DMA Channel used for Transmit Commands. You will
  145. need to change this value only if the DMA Channel 6 is being used by some
  146. other application in your system.
  147.  
  148. ----------
  149.     RX_DMA=dd [7] 6-7
  150.  
  151. This switch specifies the DMA Channel used for Transmit Commands. You will
  152. need to change this value only if the DMA Channel 7 is being used by some
  153. other application in your system.
  154.  
  155. ----------
  156.     IRQ=dd [10] 2-10
  157.  
  158. This switch specifies the IRQ level used by hardware to interrupt the CPU.
  159. You will need to change this value only if IRQ 10 is being used by some
  160. other application in your system. But make sure that it matches the jumpered
  161. IRQ on the hardware.
  162.  
  163. ----------
  164.     MPX=hh [C7] C0-FF
  165.  
  166. This switch specifies the multiplex (MPX) interrupt number to use for
  167. communication to the high-level AI-LANBIOS.  You will need to change this
  168. value only if the MPX number is in use by another application or low-level
  169. driver.
  170.  
  171. ----------
  172.     PACKET_SIZE=dddd [1500] 574-1500
  173.  
  174. This switch specifies the maximum size of transmitted IEEE 802.3 packets.
  175. You may need to change this value when using certain bridges that do not
  176. support the full 1500 byte packet size.  Even when you reduce the packet
  177. size, the low-level driver can still receive large packets.
  178.  
  179. ----------
  180.     REMOVE
  181.  
  182. This switch removes INTEL593.EXE from memory.  You must remove TSR programs
  183. in the opposite order they were loaded.  For example, if you loaded
  184. INTEL593.EXE and then AILANBIO, you must remove AILANBIO before INTEL593.EXE.
  185. For example if you have loaded
  186. INTEL593.EXE
  187. AILANBIO
  188.  
  189. To unload these copies of INTEL593.EXE and AILANBIO:
  190.  
  191. AILANBIO/REMOVE
  192. INTEL593.EXE/REMOVE
  193.  
  194. The REMOVE option will remove the most recently run copy of AILANBIO.
  195.  
  196. ----------
  197.     VERBOSE
  198.  
  199. This switch causes the INTEL593 driver to be installed and detailed
  200. information about the configuration of the INTEL593 driver to be displayed.
  201. See the messages section for a detailed description of the verbose output.
  202.  
  203.  
  204. INTEL593 messages
  205. =================
  206.  
  207. The INTEL593 driver produces two types of messages: Informative and Error. 
  208. All error messages are preceded by the text "ERROR:" and cause the INTEL593
  209. driver not to be installed.
  210.  
  211. --------
  212. MESSAGE:
  213. Intel MLM-82593(tm) AI-LANBIOS compatible driver Vn.nn 
  214.       (C) Copyright 1991 by ARTISOFT Inc.
  215.       Portions (C) Copyright 1992 by Intel Corporation
  216.  
  217. This message appears each time the low-level driver is invoked.
  218.  
  219. --------
  220. MESSAGE:
  221.            ---- MLM-82593 AI-LANBIOS Compatible driver installed ----
  222.  
  223. This message appears after the low-level driver is successfully
  224. installed. 
  225.  
  226. --------
  227. MESSAGE:
  228.            ---- MLM-82593 AI-LANBIOS Compatible driver not installed ----
  229.  
  230. This message appears if the low-level driver is not installed.  The driver
  231. will not be installed if help information is displayed or an error
  232. occurred.
  233.  
  234. --------
  235. MESSAGE:
  236.  
  237. Command line              verbose 
  238. IEEE 802.3 node address  00AA00032456   Network packet size      1500 
  239. MPX interface number     C7             IO base address          0300 
  240. Transmit DMA Channel     6              Receive  DMA Channel     7    
  241. Interrupt request (IRQ)  10             Packet type              IEEE 802.3
  242. Bytes of memory used     19520 
  243.  
  244. This message appears if the VERBOSE switch is specified.  The values
  245. displayed specify how the low-level driver is configured.  Some values may
  246. not agree with switch values you specified on the command line.  This will
  247. happen when you specify an IOBASE or RAMBASE switch value that is not a
  248. proper multiple of the allowed value.
  249.  
  250. --------
  251. MESSAGE:
  252.  
  253. Valid command line switches:
  254.     HELP
  255.     XEROX
  256.     IOBASE= Range 0000 to 03E0 hex 
  257.     TX_DMA= Range 6 to 7 decimal 
  258.     RX_DMA= Range 6 to 7 decimal 
  259.     IRQ= Range 2 to 10 decimal 
  260.     MPX= Range C0 to FF hex 
  261.     PACKET_SIZE= Range 574 to 1500 decimal 
  262.     REMOVE
  263.     VERBOSE
  264.     ?
  265.     @ Range 0 to 2048 byte switch file 
  266.  
  267. This message appears when the HELP or ? switch is used.  Each valid switch
  268. is listed with the acceptable range of values (if any) and the base (hex
  269. or decimal) that the numbers must be entered in.  The acceptable file size
  270. range for indirect files (@) is also listed.  The low-level driver is not
  271. installed when this switch is used.
  272.  
  273. --------
  274. MESSAGE:
  275.  
  276.          ---- MLM-82593 AI-LANBIOS Compatible driver removed ----
  277.  
  278. The INTEL593.EXE driver has been removed from memory.
  279.  
  280. --------
  281. MESSAGE:
  282.  
  283.          Reading Configuration Parameters from NETIDBLK 
  284.  
  285. The NETID Block was found in the memory. The parameters read from the NETID
  286. Block will override any other specified parameters.
  287.  
  288. --------
  289. ERROR:   MLM-82593 Board is not responding to initial setup. Check 
  290.      Configuration.
  291.  
  292. Meaning: The initial configuration of 82593 is not successful. 
  293.  
  294. Remedy:  Check that the configuration parameters for the hardware are OK.
  295.      Wrong IOBASE, TX_DMA or RX_DMA may cause this message to appear.
  296.  
  297. --------
  298. ERROR:   MLM-82593 Configuration failed
  299.  
  300. Meaning: The initial configure command issued to 82593 is not successful.
  301.  
  302. Remedy:  Contact your Network support. 
  303.  
  304. --------
  305. ERROR:   MLM-82593 Individual Address Setup failed
  306.  
  307. Meaning: The initial IASETUP command issued to 82593 is not successful.
  308.  
  309. Remedy:  Contact your Network support. 
  310.  
  311. --------
  312. ERROR:   MLM-82593 AI-LANBIOS Compatible driver is not loaded
  313.  
  314. Meaning: You have issued the INTEL593/REMOVE command and do not have
  315.      INTEL593.EXE loaded into memory.
  316.  
  317. Remedy:  Only issue this command after the program is loaded.
  318.  
  319. --------
  320. ERROR:   Can't REMOVE -- interrupts re-hooked
  321.  
  322. Meaning: You have attempted to remove INTEL593.EXE and the interrupts are
  323.      in use by another TSR, or INTEL593.EXE was not the last TSR
  324.      loaded.
  325.  
  326. Remedy:  Remove any TSRs loaded after INTEL593.EXE.  For example, if you
  327.      load INTEL593.EXE then AILANBIO.EXE, you must first remove
  328.      AILANBIO.EXE, then you can remove INTEL593.EXE.
  329.  
  330. --------
  331. ERROR:   Installed AI-LANBIOS Compatible driver is different version
  332.  
  333. Meaning: You have loaded a version of the INTEL593.EXE program and
  334.      attempted to remove it from memory with the /REMOVE switch.  The
  335.      version with which you are attempting to remove INTEL593.EXE is
  336.      not the same version that was loaded.
  337.  
  338. Remedy:  Remove INTEL593.EXE with the same version of the program that was
  339.      loaded.
  340.  
  341. --------
  342. ERROR:   MPX number hh is already in use - Try another number
  343.  
  344. Meaning: Multiplex (MPX) interrupt number hh is being used by another
  345.      application or low-level driver.
  346.  
  347. Remedy:  Try another MPX number.
  348.  
  349. --------
  350. ERROR:   No network hardware found at I/O base address ????H
  351.  
  352. Meaning: The MLM-82593 hardware could not be located.  This error message
  353.      appears displayed because the adapter card is not present or the
  354.      IOBASE specified on the command line is different from what is
  355.      jumpered on the adapter.
  356.  
  357. Remedy:  Check to see that the IOBASE switch specified on the
  358.      INTEL593.EXE command line matches the I/O Address setting on the
  359.      hardware.
  360.  
  361. --------
  362. ERROR:   Illegal switch - ??????=nnnn
  363.  
  364. Meaning: The switch ??????=nnnn is not a recognized switch.
  365.  
  366. Remedy:  You may only specify legal switches on the command line.
  367.  
  368. --------
  369. ERROR:   Illegal character after switch name - ??????xnnnn
  370.  
  371. Meaning: The switch ?????? is followed by a character other than "=" or
  372.      ":" or the switch does not take a value.
  373.  
  374. Remedy:  Only use the characters "=" or ":" to specify switch values and
  375.      do not place characters after switches that do not take values.
  376.  
  377. --------
  378. ERROR:   Switch value not in range - ??????=nnnn
  379.      Valid range is ssss to eeee
  380.  
  381. Meaning: The value nnnn is not in proper range.  The value ssss
  382.      represents the lowest acceptable value and the value eeee
  383.      represents the highest acceptable value.
  384.  
  385. Remedy:  Limit your range of values to the acceptable range.
  386.  
  387. --------
  388. ERROR:   Illegal digit in switch value - ??????=nnnn
  389.  
  390. Meaning: An illegal digit (character) was encountered in the numeric
  391.      switch value.
  392.  
  393. Remedy:  You must restrict numeric decimal values to the numbers 0-9. 
  394.      You must restrict hexadecimal values to the numbers 0-9 and the
  395.      letters A-F.
  396.  
  397. --------
  398. ERROR:   Cannot open indirect file - @file
  399.  
  400. Meaning: The file "file" cannot be opened as an indirect file.
  401.  
  402. Remedy:  The file must exist before it can be used as an indirect file.
  403.  
  404.  
  405. Testing INTEL593 return code (error level)
  406. ========================================
  407.  
  408. You may test the INTEL593 return code or error level in a batch file by
  409. using the IF ERRORLEVEL command.  The following error levels are returned:
  410.  
  411.      0     No error has encountered.  INTEL593 driver installed
  412.      1     MPX number is in use
  413.      2     Switch error
  414.      4     82593-MLM not installed.
  415.      5     Can't remove, different version loaded
  416.      6     Cannot remove, interrupts re-hooked
  417.      7     ERROR: Can't REMOVE -- AI-LANBIOS (R) still installed
  418. -------------------
  419.  
  420.  
  421.  
  422.